﻿/* ==============================================================================
*
*   Copyright (c) 2010, Pierre Favier
*   All rights reserved.
*
*   NTasking is free software: you can redistribute it and/or modify it
*   under the terms of the GNU General Public License as published by the
*   Free Software Foundation.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   -   Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*
*   -   Redistributions in binary form must reproduce the above
*       copyright notice, this list of conditions and the following
*       disclaimer in the documentation and/or other materials
*       provided with the distribution.
*
*   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
*   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
*   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
*   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
*   TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
*   ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
*   TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
*   THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*   SUCH DAMAGE.
*
* ============================================================================== */

using System;

namespace NTasking.Internals
{

    /// <summary>
    /// The <see cref="IContinuable"/> interface defines the properties common to all classes to which
    /// a continuation sequence of statements can be associated (i.e. selective call statements,
    /// accept statements and delay alternatives).
    /// </summary>
    internal interface IContinuable
    {

        /// <summary>
        /// Gets or Sets a delegate representing the sequence of statements to be executed.
        /// </summary>
        /// <value>A delegate representing the sequence of statements to be executed.</value>
        Action Continuation { get;  set; }


        /// <summary>
        /// Executes the continuation sequence of statements.
        /// </summary>
        void Continue();

    }


    /// <summary>
    /// The <see cref="IContinuable{RetT}"/> interface defines the properties common to all classes
    /// to which a continuation sequence of statements can be associated (i.e. selective call statements,
    /// accept statements and delay alternatives). The sequence of statements to be executed will be passed
    /// the result of the previous execution.
    /// </summary>
    /// <typeparam name="RetT">
    /// The <see cref="Type"/> of the result of the previous execution which will be passed to the
    /// continuation sequence of statements.
    /// </typeparam>
    internal interface IContinuable<RetT>
    {

        /// <summary>
        /// Gets a delegate representing the sequence of statements to be executed.
        /// </summary>
        /// <value>A delegate representing the sequence of statements to be executed.</value>
        Action<RetT> ContextualContinuation { set; }

    }

}
